Interface PolicyMap

All Superinterfaces:
IPCObject
All Known Implementing Classes:
PolicyMapImpl

public interface PolicyMap extends IPCObject
Information provided by the PKI file:

    \class PolicyMap
    
    \brief PolicyMap handles and manipulates policy maps.
    
    \example network().getDevice("Router0").getPolicyMapManager().getPolicyMapAt(0)
    
Author:
Auto-generated
  • Method Details

    • getClassCnt

      int getClassCnt()
      Information provided by the PKI file:
      
          \brief Returns the number of policies.
          
          \return int, the number of policies.
          
              
      Returns:
      int Returns a int
    • getClassAt

      PolicyMapQosClass getClassAt(int index)
      Information provided by the PKI file:
      
          \brief Returns QoS class at the specified index.
          
          \param index, the index of the QoS class of interest.
          
          \return PolicyMapQosClass, the PolicyMapQosClass object.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      PolicyMapQosClass Returns a PolicyMapQosClass
    • getTotalBandwidth

      int getTotalBandwidth()
      Information provided by the PKI file:
      
          \brief Returns the total bandwidth value.
          
          \return int, the total bandwidth value.
          
              
      Returns:
      int Returns a int
    • getTotalBandwidthPercent

      int getTotalBandwidthPercent()
      Information provided by the PKI file:
      
          \brief Returns the total bandwidth percentage.
          
          \return int, the total bandwidth percentage.
          
              
      Returns:
      int Returns a int
    • getTotalBandwidthRemainPercent

      int getTotalBandwidthRemainPercent()
      Information provided by the PKI file:
      
          \brief Returns the total bandwidth remaining percentage.
          
          \return int, the total bandwidth remaining percentage.
          
              
      Returns:
      int Returns a int
    • isBandwidthConfigured

      boolean isBandwidthConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the bandwidth value is configured, otherwise false.
          
          \return bool, true if the bandwidth value is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isPriorityConfigured

      boolean isPriorityConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if the priority is configured, otherwise false.
          
          \return bool, true if the priority is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isFairQueueConfigured

      boolean isFairQueueConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if fair queue is configured, otherwise false.
          
          \return bool, true if fair queue is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isShapeConfigured

      boolean isShapeConfigured()
      Information provided by the PKI file:
      
          \brief Returns true if traffic shaping is configured, otherwise false.
          
          \return bool, true if traffic shaping is configured, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • hasOutputFeature

      boolean hasOutputFeature()
      Information provided by the PKI file:
      
          \brief Returns true if the policy map has output feature, otherwise false.
          
          \return bool, true if the policy map has output feature, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • hasGtsFeature

      boolean hasGtsFeature()
      Information provided by the PKI file:
      
          \brief Returns true if the policy map has GTS feature, otherwise false.
          
          \return bool, true if the policy map has GTS feature, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • updateOutputPort

      void updateOutputPort()
      Information provided by the PKI file:
      
          \brief Updates the output port.
          
              
    • getMapName

      String getMapName()
      Information provided by the PKI file:
      
          \brief Returns the name of the policy map.
          
          \return string, the name of the policy map.
          
              
      Returns:
      String Returns a String
    • getMapType

      MapType getMapType()
      Information provided by the PKI file:
      
          \brief Returns the type of the policy map.
          
          \return QoS::eMapType,      the type of the policy map.
          Map types:  type_default = 0,
          type_control = 1,
          type_inspect = 2,
          type_asaInspect = 3,
          type_logging = 4
          
              
      Returns:
      MapType Returns a MapType
    • setMapType

      void setMapType(MapType mapType)
      Information provided by the PKI file:
      
          \brief Sets the type of the policy map.
          
          \param mapType,     the type of the policy map.
          Map types:  type_default = 0,
          type_control = 1,
          type_inspect = 2,
          type_asaInspect = 3
          type_logging = 4
          
              
      Parameters:
      mapType - Takes in a parameter of mapType
    • toString

      String toString(boolean isAsa)
      Information provided by the PKI file:
      
          \brief Returns the name of the policy map.
          
          \return string, the name of the policy map.
          
              
      Parameters:
      isAsa - Takes in a parameter of isAsa
      Returns:
      String Returns a String